<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TimelineController (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="TimelineController (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimelineController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/timeline/api/TimelineController.html" target="_top">Frames</a></li>
<li><a href="TimelineController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.timeline.api</div>
<h2 title="Interface TimelineController" class="title">Interface TimelineController</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">TimelineController</span></pre>
<div class="block">Controls the timeline bounds and animation features.
 <p>
 By default the timeline is disabled and can be enabled with the <code>setEnabled()</code>
 method. Once enabled, the controller is setting its interval value to the
 <a href="../../../../org/gephi/dynamic/api/DynamicModel.html" title="interface in org.gephi.dynamic.api"><code>DynamicModel</code></a>.
 <p>
 The interval can be animated using the <code>startPlay()</code> and <code>stopPlay()</code>
 methods. Configuration parameters are also available.
 <p>
 This controller also allows to lookup graph attribute columns that can be used
 as sparklines (e.g. node count, average degree...). Use the <code>selectColumn()</code>
 to create a <a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api"><code>TimelineChart</code></a> accessible from the <code>TimelineModel</code>
 <p>
 All interval values are in the same space as the <code>DynamicAPI</code> module and
 no value should eb out of the min/max bounds maintained by the <code>DynamicModel</code>.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Julian Bilcke, Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api"><code>TimelineModel</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#addListener(org.gephi.timeline.api.TimelineModelListener)">addListener</a></strong>(<a href="../../../../org/gephi/timeline/api/TimelineModelListener.html" title="interface in org.gephi.timeline.api">TimelineModelListener</a>&nbsp;listener)</code>
<div class="block">Add <code>listener</code> to the list of event listerners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#getDynamicGraphColumns()">getDynamicGraphColumns</a></strong>()</code>
<div class="block">Returns all the possible dynamic attribute columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api">TimelineModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#getModel()">getModel</a></strong>()</code>
<div class="block">Get the current model from the current workspace</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api">TimelineModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#getModel(org.gephi.project.api.Workspace)">getModel</a></strong>(<a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a>&nbsp;workspace)</code>
<div class="block">Returns the timeline model from <code>workspace</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#removeListener(org.gephi.timeline.api.TimelineModelListener)">removeListener</a></strong>(<a href="../../../../org/gephi/timeline/api/TimelineModelListener.html" title="interface in org.gephi.timeline.api">TimelineModelListener</a>&nbsp;listener)</code>
<div class="block">Remove <code>listerner</code> from the list of event listeners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#selectColumn(org.gephi.data.attributes.api.AttributeColumn)">selectColumn</a></strong>(<a href="../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</code>
<div class="block">Select a column to make a <a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api"><code>TimelineChart</code></a> of it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setCustomBounds(double, double)">setCustomBounds</a></strong>(double&nbsp;min,
               double&nbsp;max)</code>
<div class="block">Sets the timeline custom bounds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setEnabled(boolean)">setEnabled</a></strong>(boolean&nbsp;enabled)</code>
<div class="block">Sets the timeline enable status.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setInterval(double, double)">setInterval</a></strong>(double&nbsp;from,
           double&nbsp;to)</code>
<div class="block">Sets the current timeline interval.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setPlayMode(org.gephi.timeline.api.TimelineModel.PlayMode)">setPlayMode</a></strong>(<a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api">TimelineModel.PlayMode</a>&nbsp;playMode)</code>
<div class="block">Sets the play mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setPlaySpeed(int)">setPlaySpeed</a></strong>(int&nbsp;delay)</code>
<div class="block">Sets the play delay in milliseconds.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#setPlayStep(double)">setPlayStep</a></strong>(double&nbsp;step)</code>
<div class="block">Sets the play step.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#startPlay()">startPlay</a></strong>()</code>
<div class="block">Starts the timeline animation using the current delay, step size and play mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/timeline/api/TimelineController.html#stopPlay()">stopPlay</a></strong>()</code>
<div class="block">Stops the timeline animation.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getModel(org.gephi.project.api.Workspace)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api">TimelineModel</a>&nbsp;getModel(<a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a>&nbsp;workspace)</pre>
<div class="block">Returns the timeline model from <code>workspace</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workspace</code> - the workspace to get the model from</dd>
<dt><span class="strong">Returns:</span></dt><dd>the timeline model for this workspace</dd></dl>
</li>
</ul>
<a name="getModel()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api">TimelineModel</a>&nbsp;getModel()</pre>
<div class="block">Get the current model from the current workspace</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current model, or <code>null</code> if no active workspace</dd></dl>
</li>
</ul>
<a name="setCustomBounds(double, double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCustomBounds</h4>
<pre>void&nbsp;setCustomBounds(double&nbsp;min,
                   double&nbsp;max)</pre>
<div class="block">Sets the timeline custom bounds. Custom bounds still need to be included in the
 min and max bound of the time scale. The timeline will resize accordingly.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>min</code> - the lower bound</dd><dd><code>max</code> - the upper bound</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>min<code> is superior or equal than
 <code>max</code> or out of bounds</dd></dl>
</li>
</ul>
<a name="setEnabled(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnabled</h4>
<pre>void&nbsp;setEnabled(boolean&nbsp;enabled)</pre>
<div class="block">Sets the timeline enable status.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - the enabled value to set</dd></dl>
</li>
</ul>
<a name="setInterval(double, double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInterval</h4>
<pre>void&nbsp;setInterval(double&nbsp;from,
               double&nbsp;to)</pre>
<div class="block">Sets the current timeline interval. This is propagated to the <code>DynamicModel</code>
 and defines the interval the graph is filtered with.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - the lower bound</dd><dd><code>to</code> - the upper bound</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>min<code> is superior or equal than
 <code>max</code> or out of bounds</dd></dl>
</li>
</ul>
<a name="startPlay()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startPlay</h4>
<pre>void&nbsp;startPlay()</pre>
<div class="block">Starts the timeline animation using the current delay, step size and play mode.</div>
</li>
</ul>
<a name="stopPlay()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopPlay</h4>
<pre>void&nbsp;stopPlay()</pre>
<div class="block">Stops the timeline animation.</div>
</li>
</ul>
<a name="setPlaySpeed(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlaySpeed</h4>
<pre>void&nbsp;setPlaySpeed(int&nbsp;delay)</pre>
<div class="block">Sets the play delay in milliseconds. Defines the time between each interval
 shift.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delay</code> - the delay in milliseconds</dd></dl>
</li>
</ul>
<a name="setPlayStep(double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlayStep</h4>
<pre>void&nbsp;setPlayStep(double&nbsp;step)</pre>
<div class="block">Sets the play step. Defines how much the interval is moved at each step
 during animation. Defined in percentage of the total interval.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>step</code> - the step, between 0 and 1</dd></dl>
</li>
</ul>
<a name="setPlayMode(org.gephi.timeline.api.TimelineModel.PlayMode)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlayMode</h4>
<pre>void&nbsp;setPlayMode(<a href="../../../../org/gephi/timeline/api/TimelineModel.PlayMode.html" title="enum in org.gephi.timeline.api">TimelineModel.PlayMode</a>&nbsp;playMode)</pre>
<div class="block">Sets the play mode. This defines how the interval is moved.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>playMode</code> - the play mode</dd></dl>
</li>
</ul>
<a name="getDynamicGraphColumns()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDynamicGraphColumns</h4>
<pre><a href="../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>[]&nbsp;getDynamicGraphColumns()</pre>
<div class="block">Returns all the possible dynamic attribute columns. This is essentially all
 number-based dynamic columns defined in the graph table.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>all dynamic number columns in the graph table</dd></dl>
</li>
</ul>
<a name="selectColumn(org.gephi.data.attributes.api.AttributeColumn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectColumn</h4>
<pre>void&nbsp;selectColumn(<a href="../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</pre>
<div class="block">Select a column to make a <a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api"><code>TimelineChart</code></a> of it. The column must be member
 of the graph table.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - the column to select</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>column</code> is not a graph column</dd></dl>
</li>
</ul>
<a name="addListener(org.gephi.timeline.api.TimelineModelListener)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListener</h4>
<pre>void&nbsp;addListener(<a href="../../../../org/gephi/timeline/api/TimelineModelListener.html" title="interface in org.gephi.timeline.api">TimelineModelListener</a>&nbsp;listener)</pre>
<div class="block">Add <code>listener</code> to the list of event listerners.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to add</dd></dl>
</li>
</ul>
<a name="removeListener(org.gephi.timeline.api.TimelineModelListener)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeListener</h4>
<pre>void&nbsp;removeListener(<a href="../../../../org/gephi/timeline/api/TimelineModelListener.html" title="interface in org.gephi.timeline.api">TimelineModelListener</a>&nbsp;listener)</pre>
<div class="block">Remove <code>listerner</code> from the list of event listeners.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener to remove</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimelineController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/timeline/api/TimelineChart.html" title="interface in org.gephi.timeline.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/timeline/api/TimelineModel.html" title="interface in org.gephi.timeline.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/timeline/api/TimelineController.html" target="_top">Frames</a></li>
<li><a href="TimelineController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
